API endpoints

Lamps and light sources

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Create a new style energy label including the energy rating, weighted energy consumption, supplier's name and model identification code

New-style rescaled labels must be at least 36mm x 72mm, or 20mm x 54mm for the small version of the label.

Path

/api/v1/lamps/all-fields/new-style/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency class of the application. Must be one of: A B C D E F G	String
energyConsumption	Weighted energy consumption (EC) in kWh per 1000 hours, rounded up to the nearest integer. This may be up to 4 digits long.	Integer
templateSize	What size of label do you need to create? You must only use the small label on packaging less than 36mm wide. Must be one of: STANDARD SMALL	String
templateColour	Should the label be in colour or black and white? Must be one of: COLOUR BLACK_AND_WHITE	String
qrCodeUrl	Enter a link to the product information sheet. Links must start with http:// or https:// and contain at least one dot (.) character.	String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A", "energyConsumption": 1, "templateSize": "STANDARD", "templateColour": "COLOUR", "qrCodeUrl": "https://example.com" }

Create an old style energy label including the energy rating, weighted energy consumption, supplier's name and model identification code

If the product was first placed on the market on or after 1 October 2021, or hasn't been placed on the market yet, you must use the new rescaled energy label. Products placed on the market before 1 October 2021 can continue to use the old style label until 31 March 2023. Old-style labels must usually be at least 36mm x 75mm when attached to packaging. You can scale down the label if no side of the packaging is large enough to contain the label, or if the label would cover more than 50% of the surface area of the largest side. You must only scale down the label enough to meet these conditions, and the label must never be less than 14.4mm x 30mm.

Path

/api/v1/lamps/all-fields/old-style/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency class of the application. Must be one of: A++ A+ A B C D E	String
energyConsumption	Weighted energy consumption (EC) in kWh per 1000 hours, rounded up to the nearest integer. This may be up to 4 digits long.	Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A++", "energyConsumption": 1 }

Lamps and light sources: new style arrow image

Path

/api/v1/lamps/new-style/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
labelColour	The colour of the arrow image. Use a colour arrow if you can. You can use a black and white arrow if your material is being printed in black and white. You shouldn't use black and white arrows on the internet. Must be one of: COLOUR BLACK_AND_WHITE	String
efficiencyRating	Energy efficiency class of the application. Must be one of: A B C D E F G	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "labelColour": "COLOUR", "efficiencyRating": "A" }

Lamps and light sources: old style arrow image

Path

/api/v1/lamps/old-style/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	Energy efficiency class of the application. Must be one of: A++ A+ A B C D E	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A++" }

Lamps with energy rating and consumption only: Energy label

The label should be at least 36mm x 68mm when attached to packaging. If it doesn’t fit, you can reduce the height by up to 60 percent. It can be full colour or black and white.

Path

/api/v1/lamps/energy-rating-and-consumption-only/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
efficiencyRating	Energy efficiency class of the application. Must be one of: A++ A+ A B C D E	String
energyConsumption	Weighted energy consumption (EC) in kWh per 1000 hours, rounded up to the nearest integer. This may be up to 4 digits long.	Integer
templateColour	Should the label be in colour or black and white? Must be one of: COLOUR BLACK_AND_WHITE	String

Example request body

{ "outputFormat": "PDF", "efficiencyRating": "A++", "energyConsumption": 1, "templateColour": "COLOUR" }

Lamps with energy rating only: Energy label

The label should be at least 36mm x 62mm when attached to packaging. If it doesn’t fit, you can reduce the height by up to 60 percent. It can be full colour or black and white.

Path

/api/v1/lamps/energy-rating-only/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
efficiencyRating	Energy efficiency class of the application. Must be one of: A++ A+ A B C D E	String
templateColour	Should the label be in colour or black and white? Must be one of: COLOUR BLACK_AND_WHITE	String

Example request body

{ "outputFormat": "PDF", "efficiencyRating": "A++", "templateColour": "COLOUR" }

Light source packaging: energy rating arrow

This arrow must only be used on products which include a new-style rescaled energy label. The arrow must be shown on the front of the packaging if the energy label isn't on the front. It must be clearly visible and legible. You don't need to include this arrow on the packaging if the energy label is on the front.

Path

/api/v1/lamps/new-style/packaging-arrow

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
efficiencyRating	Energy efficiency class of the application. Must be one of: A B C D E F G	String
templateColour	Should the arrow be in colour or black and white? Must be one of: COLOUR BLACK_AND_WHITE	String
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String

Example request body

{ "outputFormat": "PDF", "efficiencyRating": "A", "templateColour": "COLOUR", "labelOrientation": "LEFT" }